/*
 * $Id: FrameInstance.java 1259 2007-01-09 14:23:47Z tcoupaye $
 *
 * Behavior Protocols extensions for static and runtime checking
 * developed for the Julia implementation of Fractal.
 *
 * Copyright (C) 2006
 *    Formal Methods In Software Engineering Group
 *    Institute of Computer Science
 *    Academy of Sciences of the Czech Republic
 *
 * Copyright (C) 2006 France Telecom
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 * Contact: ft@nenya.ms.mff.cuni.cz
 * Authors: Jiri Adamek <adamek@nenya.ms.mff.cuni.cz>
 *
 */

package org.objectweb.fractal.bpc.staticchecker;

/**
 * This class stores the information about a frame instance.<P>
 *
 * <em>IMPORTANT:</em> If an instance of this class describes the frame instance of the super-component
 * (the one "containing" the architecture), {@link #frameName} has to be set to 
 * <code>null</code>.
 */
public class FrameInstance {
	public String frameName;

	public InterfaceInstance[] interfaces;

	public String protocol;
	
	public int order;

	public FrameInstance(String frameName, InterfaceInstance[] interfaces,
			String protocol, int order) {
		this.frameName = frameName;
		this.interfaces = interfaces;
		this.protocol = protocol;
		this.order = order;
	}

	/**
	 * Returns the description of the interface with a given name.
	 * If the frame instance does not contain an interface with the given name, 
	 * <code>null</code> is returned. 
	 */
	public InterfaceInstance getInterfaceForName(String name) {
		for (int i = 0; i < interfaces.length; i++)
			if (name.equals(interfaces[i].interfaceName))
				return interfaces[i];
		return null;
	}
	
}
